docs(events): document the exposure flags bitmask - #278
Conversation
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
WalkthroughThe documentation explains the exported Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/web-console-docs/Events/downloading-events.mdx`:
- Around line 12-16: Update the note under “Check the flags column before you
analyse exposures” to qualify exported data by the selected export scope: state
that it includes every matching exposure within that scope, including
non-participants. Preserve the existing guidance about using the flags field to
identify real participants.
In `@docs/web-console-docs/Events/exposure-events.mdx`:
- Line 177: Update the exposure-event documentation table entry to state that
traffic allocation was “< 100%”, matching the earlier wording and clearly
expressing the percentage threshold.
- Around line 157-162: Update the participant-count SQL example to avoid merging
identical unit_uid values across dimensions: either explicitly state that the
query is pre-filtered to a single experiment and unit_type, or count distinct
experiment and unit_type together with unit_uid. Preserve the existing exposure
flag filter and UI-count intent.
- Around line 133-134: Update the documentation for flag 256 across the bit
table, trigger table, and explanatory text to state that rule-override behavior
applies only to beta SDKs. Clarify that this beta-SDK-specific flag is not
universal and preserve the correct statement about whether the SDK sets the
assigned bit.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8ddbca47-897a-43fb-ad75-3721ef8f50d7
📒 Files selected for processing (2)
docs/web-console-docs/Events/downloading-events.mdxdocs/web-console-docs/Events/exposure-events.mdx
da72fdb to
fed4c62
Compare
439de55 to
f52e5ab
Compare
What
Documents the exposure
flagscolumn so customers analysing exported event data can tell a real participant apart from a bot, an ineligible visitor, or an overridden assignment.Why
A customer exported their experiment data and their numbers didn't match the UI: more participants than reported, and some units appeared on both variants. Root cause was ignoring the
flagscolumn, which the UI applies for you but a raw export does not.Changes
exposure-events.mdx— new "The flags field" section: the full bit map, a worked read-a-value example, and the(flags & 207) = 3participant filter that matches the UI's count. Reworked the info/warning table with a Trigger column mapping each label to its flag bit (or toexperiment_idfor the one non-flag label).downloading-events.mdx— cross-link callout pointing export users at the flags section.Sourcing notes
inserter/.../EventForwardingManager.java(where the mask is built).lib/analytics/.../EventUtils.getEffectiveExposureFilter.256) is beta-SDK-only today; the207mask query works identically whether or not that bit is present, so no version fork is needed in the docs.Not done
yarn buildnot run — MDX anchor rendering unverified.🤖 Generated with Claude Code
Summary by CodeRabbit
flagscolumn is required for events-page (raw) exports to correctly distinguish real participants from all ingested exposures.flagsdocumentation with a full bitmask definition, bit-by-bit meanings, interpretation examples, and the exact conditions used by the web console for participant counts.flags(including the experiment-not-running case).